﻿#region COPYRIGHT
//--------------------------------------------------------------------------------
// <copyright file="ModifierBase.cs" company="starLiGHT Entertainment Studios">
//    Copyright (c) 2008, 2009, 2010, 2011
//       Roland Rosenkranz (Glatzemann@email.de)
// </copyright>
// <license>
//   This file is part of starLiGHT.Particles.
//
//   starLiGHT.Particles is free software: you can redistribute it and/or modify
//   it under the terms of the GNU Lesser General Public License as published by
//   the Free Software Foundation, either version 3 of the License, or
//   (at your option) any later version.
//
//   starLiGHT.Particles is distributed in the hope that it will be useful,
//   but WITHOUT ANY WARRANTY; without even the implied warranty of
//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//   GNU Lesser General Public License for more details.
//
//   You should have received a copy of the GNU Lesser General Public License
//   along with starLiGHT.Particles. If not, see http://www.gnu.org/licenses/.
//    
//   ADDITIONAL (commercial) LICENSES for starLiGHT.Particles are available on request.
// </license>
// <original_license>
//  * FLINT PARTICLE SYSTEM
//  * .....................
//  * 
//  * Author: Richard Lord
//  * Copyright (c) Richard Lord 2008-2009
//  * http://flintparticles.org
//  * 
//  * 
//  * Licence Agreement
//  * 
//  * Permission is hereby granted, free of charge, to any person obtaining a copy
//  * of this software and associated documentation files (the "Software"), to deal
//  * in the Software without restriction, including without limitation the rights
//  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
//  * copies of the Software, and to permit persons to whom the Software is
//  * furnished to do so, subject to the following conditions:
//  * 
//  * The above copyright notice and this permission notice shall be included in
//  * all copies or substantial portions of the Software.
//  * 
//  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
//  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
//  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
//  * THE SOFTWARE.
// </original_license>
// <version>
// **************[ starLiGHT.Engine SVN ]**********************
// * $Rev:: 620                   $:  Revision of last commit *
// * $Author:: unknown            $:  Author of last commit   *
// * $Date:: 2010-12-07 15:23:58 #$:  Date of last commit     *
// ************************************************************
// </version>
//--------------------------------------------------------------------------------
#endregion

namespace starLiGHT.ParticleSystem.Modifier
{
    #region Using Statements
    using System;
    using System.Collections.Generic;
    using System.Text;
    using starLiGHT.ParticleSystem.Common;

    #endregion

    /// <summary>
    /// The ModifierBase class is the abstract base class for all particle modifiers
    /// in the Particle-System. It implements the Modifier interface with a default
    /// priority of zero and empty methods for the rest of the interface.
    ///  
    /// <p>Developers creating custom modifiers may either extend the ModifierBase
    /// class or implement the Modifier interface directly. Classes that extend the 
    /// ModifierBase class need only to implement their own functionality for the 
    /// methods they want to use, leaving other methods with their default empty
    /// implementations.
    /// </summary>
    public abstract class ModifierBase : IModifier
    {
        protected int priority = 0;

        public ModifierBase()
        {
        }

        /// <summary>
        /// Returns a default priority of 0 for this modifier. Derived classes
        /// override this property if they want a different default priority.
        /// </summary>
        public virtual int Priority
        {
            get { return priority; }
            set { priority = value; }
        }

        /// <summary>
        /// This method does nothing. Some derived classes override this method
        /// to perform actions when the modifier is added to an emitter.
        /// </summary>
        /// <param name="emitter">
        /// The Emitter that the Modifier was added to.
        /// </param>
        public void addedToEmitter(Emitter emitter)
        {
        }
         
        /// <summary>
        /// This method does nothing. Some derived classes override this method
        /// to perform actions when the Modifier is removed from the emitter.
        /// </summary>
        /// <param name="emitter">The Emitter that the Modifier was removed from.</param>
        public void removedFromEmitter(Emitter emitter)
        {
        }

        /// <summary>
        /// This method does nothing. All derived classes override this method
        /// to update each particle every frame.
        /// </summary>
        /// <param name="emitter">The Emitter that created the particle.</param>
        /// <param name="particle">The particle to be updated.</param>
        /// <param name="time">The duration of the frame - used for time based updates.</param>
        public abstract void Update(Emitter emitter, Particle particle, float time);
    }
}
